Description
Retrieve at most batchSize descendants of the folder item with the given id and the given scrollId. When passing a null scrollId the initial search request is executed and the first batch of results is returned along with a scrollId which should be passed to the next call in order to retrieve the next batch of results. Ideally, the search context made available by the initial search request is kept alive during keepAlive milliseconds if keepAlive is positive. Results are not necessarily sorted. Return the results as a JSON blob.
Operation id | NuxeoDrive.ScrollDescendants |
Category | Services |
Label | Nuxeo Drive: Scroll descendants |
Requires | |
Since | |
Parameters
Signature
Implementation Information
JSON Definition
{
"id" : "NuxeoDrive.ScrollDescendants",
"label" : "Nuxeo Drive: Scroll descendants",
"category" : "Services",
"requires" : null,
"description" : "Retrieve at most batchSize descendants of the folder item with the given id and the given scrollId. When passing a null scrollId the initial search request is executed and the first batch of results is returned along with a scrollId which should be passed to the next call in order to retrieve the next batch of results. Ideally, the search context made available by the initial search request is kept alive during keepAlive milliseconds if keepAlive is positive. Results are not necessarily sorted. Return the results as a JSON blob.",
"url" : "NuxeoDrive.ScrollDescendants",
"signature" : [ "void", "blob" ],
"params" : [ {
"name" : "batchSize",
"description" : "Batch size.",
"type" : "int",
"required" : true,
"widget" : null,
"order" : 0,
"values" : [ ]
}, {
"name" : "id",
"description" : "Id of the file system item whose descendants to retrieve.",
"type" : "string",
"required" : true,
"widget" : null,
"order" : 0,
"values" : [ ]
}, {
"name" : "keepAlive",
"description" : "Optional keep alive duration in milliseconds.",
"type" : "long",
"required" : false,
"widget" : null,
"order" : 0,
"values" : [ "60000" ]
}, {
"name" : "scrollId",
"description" : "Optional scroll id.",
"type" : "string",
"required" : false,
"widget" : null,
"order" : 0,
"values" : [ ]
} ]
}